/*
 * Copyright (C) 2010-2025 Structr GmbH
 *
 * This file is part of Structr <http://structr.org>.
 *
 * Structr is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * Structr is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Structr.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.structr.core.function;

import org.apache.commons.lang3.StringUtils;
import org.structr.common.error.ArgumentCountException;
import org.structr.common.error.ArgumentNullException;
import org.structr.common.error.FrameworkException;
import org.structr.docs.*;
import org.structr.schema.action.ActionContext;

import java.util.List;

public class JoinFunction extends CoreFunction {

	@Override
	public String getName() {
		return "join";
	}

	@Override
	public List<Signature> getSignatures() {
		return Signature.forAllScriptingLanguages("list, separator");
	}

	@Override
	public Object apply(final ActionContext ctx, final Object caller, final Object[] sources) throws FrameworkException {

		try {

			assertArrayHasLengthAndAllElementsNotNull(sources, 2);

			if (sources[0] instanceof Iterable) {

				return StringUtils.join((Iterable)sources[0], sources[1].toString());

			} else if (sources[0].getClass().isArray()) {

				return StringUtils.join((Object[])sources[0], sources[1].toString());
			}

			return "";

		} catch (ArgumentNullException pe) {

			// silently ignore null arguments
			return "";

		} catch (ArgumentCountException pe) {

			logParameterError(caller, sources, pe.getMessage(), ctx.isJavaScriptContext());
			return usage(ctx.isJavaScriptContext());
		}
	}

	@Override
	public List<Usage> getUsages() {
		return List.of(
			Usage.structrScript("Usage: ${join(collection, separator)}. Example: ${join(this.names, \",\")}")
		);
	}

	@Override
	public String getShortDescription() {
		return "Joins the given collection of strings into a single string, separated by the given separator.";
	}

	@Override
	public String getLongDescription() {
		return "This function is often used in conjunction with `find()` and `extract()` to create comma-separated lists of property values.";
	}

	@Override
	public List<Language> getLanguages() {
		return List.of(Language.StructrScript);
	}

	@Override
	public List<Parameter> getParameters() {

		return List.of(
			Parameter.mandatory("collection", "collection of values to join"),
			Parameter.mandatory("separator", "separator string")
		);
	}

	@Override
	public List<Example> getExamples() {

		return List.of(
			Example.structrScript("${join(extract(find('User'), 'name'), ', ')}", "Create a comma-separated list of all the user names in the database")
		);
	}
}
